home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / rafdh12.zip / FDHELPER.DOC next >
Text File  |  1990-07-13  |  11KB  |  217 lines
  1.  
  2.   ╒═════════════════════════════════════════════════════════════════════════╕
  3.   │░░░░░░ FileDoor Helper for RemoteAccess ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  4.   ╘═════════════════════════════════════════════════════════════════════════╛
  5.  
  6.                           FileDoor Helper Version 1.0
  7.                              By: William L. Munson
  8.  
  9.                       This is another fine utility from:
  10.  
  11.                             The Munchkin's Node BBS
  12.                                 (716) 265 - 4492
  13.                       300 - 2400 baud on-line 24 hours/day
  14.                               Net/Node 1:260/238
  15.  
  16.   ╒═════════════════════════════════════════════════════════════════════════╕
  17.   │░░░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  18.   ╘═════════════════════════════════════════════════════════════════════════╛
  19.  
  20.      Have you ever wished that FileDoor (tm) could update the user's upload 
  21.    and download amounts as well as the user's flag status as soon as the user
  22.    returned to your BBS from FileDoor instead of waiting until the next day?  
  23.    Well, I felt that way also, so I created FileDoor Helper.
  24.  
  25.      FDHELPER takes the files transferred information provided by FileDoor and 
  26.    updates the users EXITINFO.BBS file to reflect any changes in the users 
  27.    status before returning the user to RemoteAccess.  This includes the users
  28.    number of files transferred and K bytes transferred.  Also FDHELPER checks
  29.    the user's upload K bytes to download K bytes ratio and if that ratio falls 
  30.    below the minimum specified in the configuration file, FDHELPER will alter 
  31.    one of the user's flags to disable that person's downloading ability.  After
  32.    the user uploads enough files to return the ratio to an acceptable level 
  33.    the program will restore the ability to download. The flag values are also 
  34.    specified in the configuration file.
  35.  
  36.  
  37.   ╒═════════════════════════════════════════════════════════════════════════╕
  38.   │░░░░░░ INSTALLATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  39.   ╘═════════════════════════════════════════════════════════════════════════╛
  40.  
  41.      In order for FDHELPER to operate properly you =MUST= include the
  42.    TYPE15 keyword in your FileDoor configuration file.
  43.  
  44.      The Type15 keyword will keep FileDoor from attempting to do the funny
  45.    tricks which it does to change the user's on-line time.
  46.  
  47.      Next run the program FDHSETUP to configure the program to your needs.
  48.    The configuration program must be run from the same directory as FDHELPER.
  49.    The available options in the setup program are:
  50.  
  51.      1)  BBS Name
  52.      2)  Registration number.
  53.      3)  Enable Flags.
  54.      4)  Disable Flags.
  55.      5)  File ratio type.
  56.      6)  Time Bank Path.
  57.      7)  Security Levels.
  58.      8)  Text colors.
  59.      9)  Exit Setup with option of saving configuration.
  60.  
  61.  
  62.      1) This entry should contain the name of your BBS EXACTLY as given in 
  63.         your registration application form or the Registration Number will not 
  64.         work properly. Note: The validity check on the registration is not
  65.         CASE sensitive.
  66.  
  67.      2) This entry should contain your Registration Number after you get my
  68.         registration reply.  Non-registered users should use 0 for this entry.
  69.  
  70.      3) This is the flag pattern used to enable downloading.   See the
  71.         description of flag patterns below for information on setting up your 
  72.         pattern.
  73.  
  74.      4) This is the flag pattern used to disable downloading.   See the
  75.         description of flag patterns below for information on setting up your 
  76.         pattern.
  77.  
  78.            The format of the Flag pattern is the same as that used for 
  79.          RemoteAccess.   The line starts with the letter of the flag (A - D)
  80.          followed by 8 action identifier symbols.
  81.  
  82.            X = Set this flag position to on.
  83.            - = Set this flag position to off.
  84.            ? = Leave this position as it was.
  85.  
  86.            Example: AX--X????? - This means set the A flag to on, off, off, 
  87.                                  on, with the rest of the flag being left as 
  88.                                  it had been.
  89.  
  90.      5) This entry will toggle between the two methods of file ratios.
  91.         The two ratio types are:
  92.            Kbytes of files - With this method you ratio on the actual number
  93.              of bytes transferred.
  94.            Number of files - With this method you ratio on the number of
  95.              files without regard to how large they are.
  96.  
  97.      6) This entry should contain the complete path to your Time Bank Account.
  98.         i.e., C:\REMOTE\ <== Note the trailing backslash.   If you do not
  99.         wish to support this feature, then leave the line blank and time 
  100.         banking will be disabled and the user's on-line time will be directly
  101.         updated. If you do not wish to give the users time credit then enter
  102.         a 0 for the upload time credit multiplier entry in the security level
  103.         selections.
  104.  
  105.            NOTE: Time Banking will only work with the program OTBANK by
  106.                  William L. Munson.  I was not able to have it ready at
  107.                  the time this was released but I will have it ready in
  108.                  the very near future.
  109.  
  110.  
  111.      7) Select this option to display a list of 10 security levels.  With
  112.         this feature you can assign separate file ratios and upload credit
  113.         values for up to 10 different levels.  The program will select the
  114.         entry with the next higher valid level for that user if you do not
  115.         have an exact match for that users level.  To disable the ratio for a
  116.         particular users level just enter a very large ratio ( say 10000 )
  117.         for that users level.
  118.  
  119.      8) Select this option to display the colors used in the different
  120.         messages displayed by the program.  You may alter any of these to
  121.         suit your preferences.  Note: You do not need a color monitor on
  122.         your computer to make use of these colors.
  123.  
  124.  
  125.      Place the .EXE and .CFG files in the same directory as FileDoor.
  126.  
  127.      FileDoor Helper may be run as either a type 7 or type 15 exit. If
  128.    you run this as a type 7 exit then you should create a small batch
  129.    file to run both Filedoor and FDHELPER.  You will need to tell FDHELPER
  130.    which comm port to use as part of the command line. The format to use
  131.    is: FDHELPER [COMM PORT]
  132.  
  133.        Where COMMPORT is 1, 2, 3 or 4.
  134.  
  135.    Here is an example of the batch file for downloading on COM1.
  136.  
  137.    FLDR-DWN.BAT  ( Example for downloading )
  138.  
  139.      REM  THIS BATCH FILE WILL WORK FOR EITHER TYPE 7 OR TYPE 15 EXITS
  140.      @ECHO OFF
  141.      FILEDOOR FILEDOOR.CFG -DD <--(D for download or U for upload)
  142.      FDHELPER 1  <--(note the port number is given on the command line)
  143.  
  144.      -------------------------
  145.  
  146.      Here is what your type 7 optional data line in your menu should
  147.    look like for the above batch file.
  148.  
  149.      *C /C FLDR-DWN   (for downloading)
  150.  
  151.      In your daily maintenance batch file place a line in it  which reads
  152.    something like this:
  153.  
  154.        DEL C:\REMOTE\FILEDOOR.UPD (use your RemoteAcess directory path)
  155.  
  156.      FILEDOOR.UPD contains the information on how many files a user has 
  157.    transferred today.  If you do not delete this file each day, the user will 
  158.    quickly run out of file download capacity as the file door program will 
  159.    think they have had a very busy day.
  160.  
  161.      Also you no longer need to run the programs FD_KEY or FD_UPD to update
  162.    the user's on-line time as this is taken care of by FileDoor Helper.
  163.  
  164.   ╒═════════════════════════════════════════════════════════════════════════╕
  165.   │░░░░░░ OPERATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  166.   ╘═════════════════════════════════════════════════════════════════════════╛
  167.  
  168.      FileDoor helper is completely FOSSIL driven for all output and will 
  169.    monitor the state of the carrier detect line and will not hang the system 
  170.    trying to output data when the carrier is not present.  Every effort has 
  171.    been made to ensure that this program will not damage your system, but I 
  172.    cannot be held responsible for any damages which may occur.
  173.  
  174.      In normal operation, after a file transfer, FDHELPER will read the
  175.    FILEDOOR.UPD file to get the info on how many files were transferred.
  176.    (Using this file for the info allows me to honor the free files and
  177.    archive credit features of filedoor.) FileDoor Helper will take that
  178.    info and update the user's records.  If a violation or correction of a
  179.    violation occurs, the program will alter the flag you specified in the
  180.    config program.
  181.  
  182.      If you also use my Time Bank program then FileDoor Helper will deposit
  183.    the upload credit time directly into the user's bank account.
  184.  
  185.      If an error occurs during operation, the program will display an error 
  186.    message to the screen and log the error to an error log called 
  187.    FDHELPER.ERR.  This will cause the program to abort and will not affect
  188.    the users record.
  189.  
  190.   ╒═════════════════════════════════════════════════════════════════════════╕
  191.   │░░░░░░ LEGAL STUFF ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  192.   ╘═════════════════════════════════════════════════════════════════════════╛
  193.  
  194.      FileDoor Helper is a Shareware program and is NOT public domain or 
  195.    freeware.  If, after a reasonable period of time (30 days), you find this 
  196.    program to be useful please send me $10.00 and the EXACT name of your board
  197.    as you will have it in the configuration file.  I will mail you your 
  198.    registration number which will get rid of the un-registered copy notice the 
  199.    program displays and also enable you use the ratio and minimum file values 
  200.    you choose instead of the default values.  You will also receive 
  201.    notification of program upgrades. If you have a FIDO net/node number, 
  202.    include the information in your registration request and I will send you 
  203.    your registration by netmail.
  204.  
  205.      If for whatever reason you decide to change the name of your BBS, you 
  206.    will have to send me a letter or netmail message containing your old BBS 
  207.    name and registration number and the new name you will be using.  I will 
  208.    send you a new registration number free of charge.
  209.  
  210.      For your convenience, I have included a pre-printed registration form.
  211.      The form is in the file FDHELPER.REG
  212.  
  213.      NOTE: For those of you who have read this far, a bug report or suggestion 
  214.            for future improvements/features MAY get you a free registration in 
  215.            the mail.
  216.  
  217.